/**
 *
 *    geo-platform
 *    Rich webgis framework
 *    http://geo-platform.org
 *   ====================================================================
 *
 *   Copyright (C) 2008-2021 geoSDI Group (CNR IMAA - Potenza - ITALY).
 *
 *   This program is free software: you can redistribute it and/or modify it
 *   under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version. This program is distributed in the
 *   hope that it will be useful, but WITHOUT ANY WARRANTY; without
 *   even the implied warranty of MERCHANTABILITY or FITNESS FOR
 *   A PARTICULAR PURPOSE. See the GNU General Public License
 *   for more details. You should have received a copy of the GNU General
 *   Public License along with this program. If not, see http://www.gnu.org/licenses/
 *
 *   ====================================================================
 *
 *   Linking this library statically or dynamically with other modules is
 *   making a combined work based on this library. Thus, the terms and
 *   conditions of the GNU General Public License cover the whole combination.
 *
 *   As a special exception, the copyright holders of this library give you permission
 *   to link this library with independent modules to produce an executable, regardless
 *   of the license terms of these independent modules, and to copy and distribute
 *   the resulting executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the license of
 *   that module. An independent module is a module which is not derived from or
 *   based on this library. If you modify this library, you may extend this exception
 *   to your version of the library, but you are not obligated to do so. If you do not
 *   wish to do so, delete this exception statement from your version.
 */
package org.geosdi.geoplatform.rs.support.linker;

import org.geosdi.geoplatform.rs.support.request.linker.GPBaseLinkerRequest;
import org.geosdi.geoplatform.rs.support.request.linker.IGPLinkerType;
import org.geosdi.geoplatform.rs.support.response.GPStatusResponse;
import org.springframework.beans.factory.InitializingBean;

import javax.annotation.Nonnull;
import java.io.Serializable;

import static com.google.common.base.Preconditions.checkArgument;
import static javax.annotation.meta.When.NEVER;

/**
 * @author Giuseppe La Scaleia - CNR IMAA geoSDI Group
 * @email giuseppe.lascaleia@geosdi.org
 */
public interface GPLinkerStrategy<Request extends GPBaseLinkerRequest> extends InitializingBean {

    /**
     * @param theRequest
     * @param <Status>
     * @return {@link Status}
     * @throws Exception
     */
    <Status extends GPStatusResponse> Status link(@Nonnull(when = NEVER) Request theRequest) throws Exception;

    /**
     * @return {@link StrategyKey}
     */
    <StrategyKey extends IGPLinkerStrategyKey> StrategyKey getStrategyKey();

    /**
     * @param <StrategyType>
     * @return {@link StrategyType}
     */
    <StrategyType extends GPLinkerStrategyType> StrategyType getStrategyType();

    /**
     * @return {@link Class<Request>}
     */
    Class<Request> forRequest();

    interface IGPLinkerStrategyKey extends Serializable {

        /**
         * @return {@link IGPLinkerType}
         */
        IGPLinkerType getKey();

        /**
         * @param theValue
         * @return {@link IGPLinkerStrategyKey}
         */
        static IGPLinkerStrategyKey of(@Nonnull(when = NEVER) IGPLinkerType theValue) {
            return new GPLinkerStrategyKey(theValue);
        }

        class GPLinkerStrategyKey implements IGPLinkerStrategyKey {

            private static final long serialVersionUID = 2962343036787785310L;
            //
            private final IGPLinkerType key;

            /**
             * @param theKey
             */
            protected GPLinkerStrategyKey(@Nonnull(when = NEVER) IGPLinkerType theKey) {
                checkArgument(theKey != null, "The Parameter Key must not be null.");
                this.key = theKey;
            }

            /**
             * @return {@link IGPLinkerType}
             */
            @Override
            public IGPLinkerType getKey() {
                return this.key;
            }

            @Override
            public boolean equals(Object o) {
                if (this == o) return true;
                if (!(o instanceof GPLinkerStrategyKey)) return false;
                GPLinkerStrategyKey that = (GPLinkerStrategyKey) o;
                return key != null ? key.equals(that.key) : that.key == null;
            }

            @Override
            public int hashCode() {
                return key != null ? key.hashCode() : 0;
            }

            @Override
            public String toString() {
                return getClass().getSimpleName() + "{"
                        + "key = " + key +
                        '}';
            }
        }
    }

    interface GPLinkerStrategyType {

        /**
         * @return {@link String}
         */
        String getStrategyType();
    }
}